Assurance Diagnostics API

19.0.x
(0 reviews)

Example XML

Example Request & Response Payloads for each API Method

GetExchangeDetails

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sup="http://webservices.opalonline.co.uk/SupportalAPIWS">
   <soapenv:Header/>
   <soapenv:Body>
      <sup:GetExchangeDetails>
         <sup:request>
            <sup:CLI>01610000000</sup:CLI>
         </sup:request>
      </sup:GetExchangeDetails>
   </soapenv:Body>
</soapenv:Envelope>

GetCredentials

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetCredentials xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <Username />
        <AgentID>2111</AgentID>
        <CustomerReference xsi:type="CLIType">
          <CLI>01610000000</CLI>
        </CustomerReference>
      </request>
    </GetCredentials>
  </soap:Body>
</soap:Envelope>

SearchAuthenticationLogs

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sup="http://webservices.opalonline.co.uk/SupportalAPIWS">
   <soapenv:Header/>
   <soapenv:Body>
      <sup:SearchAuthenticationLogs>
         <sup:request>
            <sup:CLI>01610000000</sup:CLI>
            <sup:SearchCriteria>UsernameOnly</sup:SearchCriteria>
         </sup:request>
      </sup:SearchAuthenticationLogs>
   </soapenv:Body>
</soapenv:Envelope>

GetAuthenticationLogs

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sup="http://webservices.opalonline.co.uk/SupportalAPIWS">
   <soapenv:Header/>
   <soapenv:Body>
      <sup:GetAuthenticationLogs>
         <sup:request>
            <sup:CustomerIdentifierType>CASR</sup:CustomerIdentifierType>
            <sup:CustomerIdentifier>SOGEA113</sup:CustomerIdentifier>
         </sup:request>
      </sup:GetAuthenticationLogs>
   </soapenv:Body>
</soapenv:Envelope>

GetAuthenticationStatus

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sup="http://webservices.opalonline.co.uk/SupportalAPIWS">
   <soapenv:Header/>
   <soapenv:Body>
      <GetAuthenticationStatus>
         <request>
            <CustomerIdentifierType>CASR</CustomerIdentifierType>
            <CustomerIdentifier>SOGEA113</CustomerIdentifier>
         </request>
      </GetAuthenticationStatus>
   </soapenv:Body>
</soapenv:Envelope>

GetLineData

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetLineData xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
        <StartDateTime>2024-09-27T00:00:00</StartDateTime>
        <EndDateTime>2024-09-28T00:00:00</EndDateTime>
      </request>
    </GetLineData>
  </soap:Body>
</soap:Envelope>

GetProfileHistory

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetProfileHistory xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
      </request>
    </GetProfileHistory>
  </soap:Body>
</soap:Envelope>

GetValidLineProfiles

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetValidLineProfiles xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
      </request>
    </GetValidLineProfiles>
  </soap:Body>
</soap:Envelope>

GetSubscriberIPAddress

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetSubscriberIPAddress xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
      </request>
    </GetSubscriberIPAddress>
  </soap:Body>
</soap:Envelope>

GetSyncStatus

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetSyncStatus xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
      </request>
    </GetSyncStatus>
  </soap:Body>
</soap:Envelope>

IssueServiceTestRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sup="http://webservices.opalonline.co.uk/SupportalAPIWS">
   <soapenv:Header/>
   <soapenv:Body>
      <sup:IssueFibreServiceTestRequest>
         <sup:request>
            <sup:CASR>SOGEA113</sup:CASR>
            <sup:Intrusive>Yes</sup:Intrusive>
         </sup:request>
      </sup:IssueFibreServiceTestRequest>
   </soapenv:Body>
</soapenv:Envelope>

*GetLatestServiceTestResult

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetLatestFibreServiceTestResult xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <ServiceTestKeyRef>ddec3d98-347e-4c7e-aa02-bba4bd61be69</ServiceTestKeyRef>
        <CASR>SOGEA113</CASR>
        <ServiceTestID>0</ServiceTestID>
        <ProvidePerformanceStats>false</ProvidePerformanceStats>
      </request>
    </GetLatestFibreServiceTestResult>
  </soap:Body>
</soap:Envelope>

GetFibreServiceTestHistory

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetFibreServiceTestHistory xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI xsi:nil="true" />
        <CASR>SOGEA113</CASR>
        <ReturnTestResultsRequestedAfter xsi:nil="true" />
      </request>
    </GetFibreServiceTestHistory>
  </soap:Body>
</soap:Envelope>

IssueMetascriptTest

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <IssueMetascriptTest xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
      </request>
    </IssueMetascriptTest>
  </soap:Body>
</soap:Envelope>

*GetJDSUTestStatus

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetJDSUTestStatus xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <TestID>64498544</TestID>
      </request>
    </GetJDSUTestStatus>
  </soap:Body>
</soap:Envelope>

GetJDSUTestResults

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetJDSUTestResults xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <TestID>64498544</TestID>
      </request>
    </GetJDSUTestResults>
  </soap:Body>
</soap:Envelope>

GetJDSUTestHistory

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetJDSUTestHistory xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
        <TestType>MetaScript Test</TestType>
        <ReturnTestResultsRequestedAfter xsi:nil="true" />
      </request>
    </GetJDSUTestHistory>
  </soap:Body>
</soap:Envelope>

IssueTAMTest

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <IssueTAMTest xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
      </request>
    </IssueTAMTest>
  </soap:Body>
</soap:Envelope>

GetLatestTAMTestResult

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetLatestTAMTestResult xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <Username />
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
      </request>
    </GetLatestTAMTestResult>
  </soap:Body>
</soap:Envelope>

GetLastCompletedTAMTestResult

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetLastCompletedTAMTestResult xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
      </request>
    </GetLastCompletedTAMTestResult>
  </soap:Body>
</soap:Envelope>

GetTAMTestHistory

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetTAMTestHistory xmlns="http://webservices.opalonline.co.uk/SupportalAPIWS">
      <request>
        <AgentID>2111</AgentID>
        <CLI>01610000000</CLI>
        <ReturnTestResultsRequestedAfter xsi:nil="true" />
      </request>
    </GetTAMTestHistory>
  </soap:Body>
</soap:Envelope>

Reviews